package com.kymatrix.mpo.plus.bpm.server.service;

import com.kymatrix.mpo.plus.bpm.server.model.entity.definition.BpmCategoryEntity;
import com.kymatrix.mpo.plus.bpm.server.model.form.category.PageQueryBpmCategoryReq;
import com.kymatrix.mpo.plus.bpm.server.model.form.category.PageQueryBpmCategoryResp;
import com.kymatrix.mpo.plus.bpm.server.model.form.category.SaveBpmCategoryReq;
import com.kymatrix.mpo.plus.bpm.server.model.form.category.UpdateBpmCategoryReq;
import com.kymatrix.mpo.plus.common.business.common.PageResp;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.validation.Valid;

import static com.kymatrix.mpo.plus.common.util.CollectionUtils.convertMap;


/**
 * BPM 流程分类 Service 接口
 *
 */
public interface BpmCategoryService {

    /**
     * 创建流程分类
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    String createCategory(@Valid SaveBpmCategoryReq createReqVO);

    /**
     * 更新流程分类
     *
     * @param updateReqVO 更新信息
     */
    void updateCategory(@Valid UpdateBpmCategoryReq updateReqVO);

    /**
     * 删除流程分类
     *
     * @param id 编号
     */
    void deleteCategory(String id);

    /**
     * 获得流程分类
     *
     * @param id 编号
     * @return BPM 流程分类
     */
    BpmCategoryEntity getCategory(String id);

    /**
     * 获得流程分类分页
     *
     * @param pageReqVO 分页查询
     * @return 流程分类分页
     */
    PageResp<PageQueryBpmCategoryResp> getCategoryPage(PageQueryBpmCategoryReq pageReqVO);

    /**
     * 获得流程分类 Map，基于指定编码
     *
     * @param codes 编号数组
     * @return 流程分类 Map
     */
    default Map<String, BpmCategoryEntity> getCategoryMap(Collection<String> codes) {
        return convertMap(getCategoryListByCode(codes), BpmCategoryEntity::getCode);
    }

    /**
     * 获得流程分类列表，基于指定编码
     *
     * @return 流程分类列表
     */
    List<BpmCategoryEntity> getCategoryListByCode(Collection<String> codes);

    /**
     * 获得流程分类列表，基于指定状态
     *
     * @param status 状态
     * @return 流程分类列表
     */
    List<BpmCategoryEntity> getCategoryListByStatus(String status);

}
